Robotic Automation Sync REST API Commands

This section explains how to integrate your third-party or homegrown application with robotic automation to allow sending new sync tasks via the API.

A conversation can last up to two hours after which it will be terminated.

To execute a conversation:

1.

Use the Begin Conversation operation to send a request to begin a conversation with the Real-Time Server. You must specify the invoker idle timeout (this timeout checks the idle time between the begin conversation response and the first invocation. It then checks the time between the first invocation response and the second invocation, and so on). The Real-Time Server creates a conversation ID. See Sync Begin Conversation Operation

2.

Use the Sync Invocation operation to send the first task. The Real-Time Server assigns a dedicated robot to the conversation, and adds the task to the sync task queue. The robot is assigned for the lifecycle of the conversation (a conversation can include several automation requests). The assigned robot executes the task, sends a reply to the invoker and then waits for the invoker’s next task or for the termination of the conversation. See Sync Invoke Operation.

3.

Repeat for as many tasks as are required.

4.

Use the End Conversation operation to terminate the conversation. the robot is released. See Sync End Conversation Operation

If a synced invocation is orphaned, backlogged or removed, the conversation is closed by the microservice.